home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / cmds.fmt / scvs.man < prev    next >
Encoding:
Text File  |  1991-10-30  |  17.1 KB  |  399 lines
  1.  
  2.  
  3.  
  4. SCVS                      User Commands                      SCVS
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NNAAMMEE
  11.      scvs - Sprite Concurrent Version System
  12.  
  13. SSYYNNOOPPSSIISS
  14.      ssccvvss [_s_c_v_s__o_p_t_i_o_n_s] [_c_v_s__o_p_t_i_o_n_s] _c_o_m_m_a_n_d  [_c_o_m_m_a_n_d__o_p_t_i_o_n_s]
  15.      [_c_o_m_m_a_n_d__a_r_g_s]
  16.  
  17. OOPPTTIIOONNSS
  18.      --VV             Print out verbose status messages during pro-
  19.                     cessing.
  20.  
  21.      --DD             Print out debugging information.
  22.  
  23.      --hheellpp          Print a summary of the  command-line  options
  24.                     and exit without updating any targets.
  25.  
  26. _________________________________________________________________
  27.  
  28.  
  29. DDEESSCCRRIIPPTTIIOONN
  30.      SSccvvss is a front end to the ccvvss source control system,  which
  31.      in  turn is turn a front end for rrccss. It would probably help
  32.      to be familiar with both ccvvss and  rrccss  before  dealing  with
  33.      ssccvvss.   SSccvvss has the following features in addition to those
  34.      of ccvvss and rrccss:
  35.  
  36.      o+    A configuration file is used to specify the root of the
  37.           ccvvss  repository, rather than an environment variable or
  38.           a command line option.
  39.  
  40.      o+    SSccvvss keeps track of who has copies  of  which  modules.
  41.           When  you  check  out a module ssccvvss will tell you about
  42.           other copies of the same module  you  might  have,  and
  43.           about other users that have copies of the module.  This
  44.           allows users to coordinate  their  modifications  to  a
  45.           module.
  46.  
  47.      o+    Changes to several modules can be committed  simultane-
  48.           ously.
  49.  
  50.      o+    SSccvvss remembers the options used to checkout  a  module,
  51.           so  that  subsequent updates of the module use the same
  52.           options, thus guaranteeing that the same version of the
  53.           module is updated.
  54.  
  55.      o+    SSccvvss has limited support for  symbolic  links.  When  a
  56.           module  is  checked  into  the  repository any symbolic
  57.           links  it  contains  are  stored  in  a   file   called
  58.           _S_C_V_S/_l_i_n_k_s.   When a module is checked out its symbolic
  59.           links are created from the contents of _S_C_V_S/_l_i_n_k_s.
  60.  
  61.  
  62.  
  63.  
  64.  
  65. Sprite v.1.0       Printed:  October 29, 1991                   1
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72. SCVS                      User Commands                      SCVS
  73.  
  74.  
  75.  
  76. CCOOMMMMAANNDDSS
  77.      Each invocation of ssccvvss must specify a particular command to
  78.      be  performed.  Most of these commands are slight variations
  79.      on the corresponding ccvvss commands.
  80.  
  81.      aadddd [--mm '_m_e_s_s_a_g_e'] _f_i_l_e_s...
  82.           Create a new  file  or  directory  in  the  repository.
  83.           Files  are not actually added to the repository until a
  84.           ccoommmmiitt command is issued. See the ccvvss man page for more
  85.           details.
  86.  
  87.      cchheecckkoouutt [--QQqqllnnffPPii] [--cc] [--rr _t_a_g | --DD _d_a_t_e] _m_o_d_u_l_e_s...
  88.           Retrieves copies of  the  specified  modules  from  the
  89.           repository.   For  each  module a subdirectory with the
  90.           module's name is made in the current directory and  the
  91.           module's  source  tree  is put in the subdirectory. The
  92.           default is to check out the most recent version of  the
  93.           module,  although  a  particular version can be checked
  94.           out by using either the --rr or --DD  options,  which  will
  95.           check  out  a  version  matching the given tag or date,
  96.           respectively. The semantics of the ssccvvss  checkout  com-
  97.           mand  differ  from  ccvvss's in that empty directories are
  98.           pruned unless the --PP option  is  given.   Empty  direc-
  99.           tories  usually  occur  if you check out a version of a
  100.           module from before a directory was created.  The --QQ and
  101.           --qq  options cause varying degrees of quietness, and the
  102.           --ll option causes the command to not be recursive.   The
  103.           cchheecckkoouutt  command  will tell you of other copies of the
  104.           module that you might have, and about other users  that
  105.           have  copies  of the module.  If you are checking out a
  106.           version to go off on your own  and  make  changes  that
  107.           will  never be checked back in, then you should use the
  108.           -_i option.  You will not be listed as having  an  offi-
  109.           cial  copy  of  the module, so other people will not be
  110.           told that you have a copy.  Everything else  works  the
  111.           same,  however.   ccoo can be used as an abbreviation for
  112.           cchheecckkoouutt.
  113.  
  114. [_f_i_l_e_s...]
  115.      ccoommmmiitt  [--ffnnll]  [--mm  '_l_o_g__m_e_s_s_a_g_e']  [--rr  _r_e_v_i_s_i_o_n]  [_m_o_d_u_l_e_s...]
  116.           The ccoommmmiitt command is used to check in the changes made
  117.           to your copies of modules.  If no modules are specified
  118.           then the current directory is checked in.  SSccvvss differs
  119.           from ccvvss in that multiple modules  can  be  checked  in
  120.           simultaneously,  and  that  commit  is recursive.  SSccvvss
  121.           achieves this by locking all  modules,  verifying  that
  122.           they are up-to-date with the sources in the repository,
  123.           then committing the changes. SSccvvss will  also  update  a
  124.           snapshot  or installed copy of the sources as indicated
  125.           in the _S_C_V_S._c_o_n_f_i_g file (see FFIILLEESS section below).  The
  126.           --ff  option  allows you to commit files that do not con-
  127.           tain the RCS $Id or $Header keywords.  The --rr sets  the
  128.  
  129.  
  130.  
  131. Sprite v.1.0       Printed:  October 29, 1991                   2
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138. SCVS                      User Commands                      SCVS
  139.  
  140.  
  141.  
  142.           RCS version number, and the --nn option causes any commit
  143.           command in the module database to not be run. If the --mm
  144.           option  is not specified than an editor will be invoked
  145.           to allow you to enter the log message.  ccii can be  used
  146.           as an abbreviation for ccoommmmiitt.
  147.  
  148.      ddiiffff [--llRR] [_r_c_s_d_i_f_f__o_p_t_i_o_n_s] [_f_i_l_e_s...]
  149.           Same as for ccvvss. Runs rrccssddiiffff on the  specified  files,
  150.           or  on  only those files that you have changed. DDiiffff is
  151.           recursive unless the --ll option  is  specified.   If  no
  152.           options  are  given ddiiffff will print out the differences
  153.           between your copy of the file and the copy you  checked
  154.           out,  i.e.  it prints the changes you made to the file.
  155.           If the --RR option is given then the differences  between
  156.           your copy of the file and the current version is given.
  157.           This is useful if your copy is out-of-date and you want
  158.           to see what changed.  See the rrccssddiiffff man page for more
  159.           details on the options.
  160.  
  161.      ddoonnee [--dd] _m_o_d_u_l_e_s...
  162.           When you have finished with a module you should use the
  163.           ddoonnee  command,  so that ssccvvss can update its database of
  164.           module copies.  If the --dd option  is  given  then  your
  165.           copy  of  the  module  will  be  deleted.  If your copy
  166.           differs from the repository ssccvvss will ask  you  whether
  167.           or  not  you  are  really  done.  Make sure you really,
  168.           truly are done before running  this  command,  particu-
  169.           larly with the --dd option.
  170.  
  171.      iinnffoo [--ll] [_f_i_l_e_s...]
  172.           Prints out status information about your sources.  Out-
  173.           put  is  the  same  as for the uuppddaattee command.  IInnffoo is
  174.           recursive unless the --ll option is given.
  175.  
  176.      jjooiinn [--QQqqff] [--rr _t_a_g | --DD _d_a_t_e] _f_i_l_e_s...
  177.           Same as for ccvvss. Used to merge in a new vendor  release
  178.           of  a  software  package.   See  the  ccvvss  man page for
  179.           details.
  180.  
  181.      lloocckk [--rrww] [_m_o_d_u_l_e_s...]
  182.           Each ssccvvss command locks the module  in  the  repository
  183.           before  mucking  around  with  it, thus preventing con-
  184.           current ssccvvss commands from creating chaos.  If you wish
  185.           to  run  several  ssccvvss  commands without allowing other
  186.           users to run commands inbetween you can  use  lloocckk.   A
  187.           common  example is committing your changes to a module.
  188.           If you don't lloocckk the module first there are  potential
  189.           races  between the time you update your sources and the
  190.           time you commit them, and between the time  you  commit
  191.           them  and  update the installed copy.  To prevent these
  192.           races you should lloocckk any modules you want  to  commit,
  193.           then run any ccoommmmiitt commands, verify that the installed
  194.  
  195.  
  196.  
  197. Sprite v.1.0       Printed:  October 29, 1991                   3
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204. SCVS                      User Commands                      SCVS
  205.  
  206.  
  207.  
  208.           sources are correct, then uunnlloocckk the modules.   The  --ww
  209.           option  creates a write lock (the default), so that you
  210.           have exclusive access to the  module.   The  --rr  option
  211.           creates  a  read lock, allowing other users to read the
  212.           module but not  modify  it.   See  the  uunnlloocckk  command
  213.           below.
  214.  
  215.      lloogg [--ll] [_r_l_o_g__o_p_t_i_o_n_s] [_f_i_l_e_s...]
  216.           Same as for ccvvss. Does an rrlloogg on the  specified  files,
  217.           or  on  every  file  in  the  current directory. LLoogg is
  218.           recursive unless the --ll option is specified.   See  the
  219.           ccvvss man page for details.
  220.  
  221.      ppaacckk [--ll] [_d_i_r_s...]
  222.           The pack command is used to put entries  for  all  sym-
  223.           bolic  links  in  the given directories (or the current
  224.           directory) into the file _S_C_V_S/_l_i_n_k_s (see FFIILLEESS  section
  225.           below).  This file can then be used later by the uunnppaacckk
  226.           command to recreate the symbolic links. The  ppaacckk  com-
  227.           mand is run implicitly during a ccoommmmiitt, and is not usu-
  228.           ally invoked explicitly.  PPaacckk  is   recursive,  unless
  229.           the --ll option is given.
  230.  
  231. _m_o_d_u_l_e_s...
  232.      ppaattcchh  [--QQqqllff]  [--ss|--tt]  [--rr  _t_a_g|--DD  _d_a_t_e  [--rr   _t_a_g|--DD   _d_a_t_e]]
  233.           Same  as for ccvvss.  Creates a ppaattcchh file between the two
  234.           versions of the modules.  See  the  ccvvss  man  page  for
  235.           details.
  236.  
  237.      rreemmoovvee _f_i_l_e_s...
  238.           Same as for ccvvss. Removes the specified files  from  the
  239.           repository.   The  files are not actually deleted until
  240.           the current module is ccoommmmiittted.  See the ccvvss man  page
  241.           for details.
  242.  
  243.      ssttaattuuss [--ll] [_f_i_l_e_s...]
  244.           Same as for ccvvss. Prints out the  rrccss  version  in  your
  245.           copy  of  the  file  and the current rrccss version of the
  246.           file in the repository.  SSttaattuuss is recursive unless the
  247.           --ll  option  is  specified.   See  the  ccvvss man page for
  248.           details.
  249.  
  250.      ttaagg [--QQqqllffnn] [--dd] [--rr _t_a_g|--DD _d_a_t_e] _s_y_m_b_o_l_i_c__t_a_g _m_o_d_u_l_e_s...
  251.           Same as for ccvvss. Assigns a symbolic  tag  name  to  the
  252.           given  (or current) version of the sources in the repo-
  253.           sitory.  See the ccvvss man page for details.
  254.  
  255.      uunnlloocckk [--aa] [_m_o_d_u_l_e_s...]
  256.           Removes any locks you have on the modules.  If  the  --aa
  257.           option  is  given  then  all  locks  on  the module are
  258.           removed.  See the lloocckk command above.
  259.  
  260.  
  261.  
  262.  
  263. Sprite v.1.0       Printed:  October 29, 1991                   4
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270. SCVS                      User Commands                      SCVS
  271.  
  272.  
  273.  
  274.      uunnppaacckk [--ll] [_d_i_r_s...]
  275.           Creates symbolic links in the specified directories (or
  276.           the   current  directory)  from  the  contents  of  the
  277.           SCVS.links file.  The uunnppaacckk command is run  implicitly
  278.           during a cchheecckkoouutt or uuppddaattee, and is not usually invoked
  279.           explicitly.  UUnnppaacckk is  recursive, unless the --ll option
  280.           is given.
  281.  
  282. [[_f_i_l_e_s...]]
  283.      uuppddaattee [--QQqqllffppBB] [--ee _d_i_r]]  [[--dd]]  [[--rr  _t_a_g||--
  284.           DD  _d_a_t_e]]  [[_m_o_d_u_l_e_s...]]
  285.           The update command is  used  to  make  your  copies  of
  286.           modules  up-to-date with the sources in the repository.
  287.           The default behavior is to bring your  copy  up-to-date
  288.           with  the  version  that was checked out, although this
  289.           can be modified with the --rr or --DD  options.   You  will
  290.           have to specify these options to subsequent uuppddaattee com-
  291.           mands if you wish to continue to use a  different  ver-
  292.           sion  than  the  one  that  was checked out.  UUppddaattee is
  293.           recursive by default, but this can be overridden by the
  294.           --ll  option.   The  --BB  option  will cause uuppddaattee to not
  295.           update your sources with any  new  directories  in  the
  296.           repository.   The  default  behavior  is to do so (this
  297.           differs from ccvvss).  See  the  ccvvss  man  page  for  more
  298.           details  on  the  algorithm  used  by uuppddaattee and for an
  299.           explanation of its output.
  300.  
  301.      wwhhoo [_m_o_d_u_l_e_s...]
  302.           Prints out the names of  users  who  have  checked  out
  303.           copies of the modules.
  304.  
  305. FFIILLEESS
  306.      SSCCVVSS..ccoonnffiigg
  307.           When ssccvvss is invoked it works its way up the  directory
  308.           tree  looking  for the file SSCCVVSS..ccoonnffiigg.  The first one
  309.           that is found is used.  The SSCCVVSS..ccoonnffiigg  file  has  the
  310.           following  format.   A  blank  line or a line beginning
  311.           with '#' is ignored. A  line  beginning  with  ccvvssrroooott::
  312.           specifies  the pathname of the ccvvss root directory.  The
  313.           following is a sample SCVS.config file for  the  Sprite
  314.           kernel sources.
  315.  
  316.                     cvsroot: /sprite/src/kernel/Cvsroot
  317.                     installdir: /sprite/src/kernel
  318.  
  319.  
  320.      SSCCVVSS//aarrggss
  321.           This file is created by the cchheecckkoouutt  command,  and  is
  322.           put in the top-level subdirectory of a module copy.  It
  323.           contains the arguments passed to the cchheecckkoouutt  command,
  324.           so that subsequent uuppddaattee commands use the correct ver-
  325.           sion of the sources.
  326.  
  327.  
  328.  
  329. Sprite v.1.0       Printed:  October 29, 1991                   5
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336. SCVS                      User Commands                      SCVS
  337.  
  338.  
  339.  
  340.      SSCCVVSS//lliinnkkss
  341.           The SSCCVVSS//lliinnkkss file contains information about symbolic
  342.           links  in  the module sources. Each line is of the form
  343.           "_l_i_n_k_N_a_m_e _t_a_r_g_e_t", where _l_i_n_k_N_a_m_e is the  name  of  the
  344.           symbolic  link to be created, and _t_a_r_g_e_t is the file to
  345.           which the link points.  SSCCVVSS//lliinnkkss is  created  by  the
  346.           ppaacckk  and ccoommmmiitt commands, and read by the cchheecckkoouutt and
  347.           uuppddaattee commands.  Each subdirectory of a module has its
  348.           own SSCCVVSS//lliinnkkss file.
  349.  
  350.      SSCCVVSS//uusseerrss
  351.           The SSCCVVSS//uusseerrss file exists in each module in the  repo-
  352.           sitory  and  contains  information  about the users who
  353.           have the module checked out.  Each line is of the form:
  354.           "_u_s_e_r  _p_a_t_h  _d_a_t_e",  where _u_s_e_r is the name of the user
  355.           who has the module checked out, _p_a_t_h is the pathname of
  356.           their copy of the module, and _d_a_t_e is the time when the
  357.           copy was checked out.
  358.  
  359.      SSCCVVSS//lloocckkss
  360.           Exists in the module directory in  the  repository  and
  361.           contains  a  list of locks on the module.  Each line is
  362.           of the form "_t_y_p_e _u_s_e_r _d_a_t_e", where _t_y_p_e is one of _r or
  363.           _w,  _u_s_e_r  is the login name of the lock owner, and _d_a_t_e
  364.           is the time the lock was created.
  365.  
  366. SSEEEE AALLSSOO
  367.      rrccss(1), ccii(1),  ccoo(1),  rrccssddiiffff(1),  ppaattcchh(1),  rrccssmmeerrggee(1),
  368.      rrlloogg(1), ccvvss(1)
  369.  
  370. KKEEYYWWOORRDDSS
  371.      source control, rcs, cvs
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395. Sprite v.1.0       Printed:  October 29, 1991                   6
  396.  
  397.  
  398.  
  399.